home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / e40ds1.arc / READ.IT < prev   
Text File  |  1989-03-10  |  10KB  |  232 lines
  1. ┌───────────────────────────┐
  2. │E! SHORT INSTALLATION GUIDE│
  3. └───────────────────────────┘
  4.  
  5. To install E!:
  6.  
  7. 1/  Unpak the files E!40DSK1.ARC, E!40DSK2.ARC and E!40DSK3.ARC using ARC-E
  8. in  a  directory  called C:\E! (or whatever name you prefer). Do not delete
  9. these  files.  They  may  be  useful  to  you  if E! files are lost. Please
  10. distribute  E!40DSK1.ARC,  E!40DSK2.ARC  and  E!40DSK3.ARC  instead  of  E!
  11. individual files.
  12.  
  13. If  you  have  a two diskette drives system be aware that all E! files will
  14. not  fit  on  a  single diskette. E!40DSK1 contains all files really needed
  15. to  execute  E!.  E!40DSK2  contains  E!  documentation, utilities and font
  16. files.   E!40DISK3   contains   the   H!  and  P!  utilities  and  the  API
  17. documentation.
  18.  
  19. 2/  At  the  DOS  prompt  enter SET E!=C:\E! (drive and directory where you
  20. copied  E!  files). If you have a RAM drive copy all files to it and use it
  21. as E! environment variable.
  22.  
  23. 3/  At  the DOS prompt enter E! E!.PRO and "uncomment" all options you want
  24. to activate. E!.PRO is a self-explanatory file. Save it using F4. This step
  25. is not mandatory and you may leave the main profile unchanged (that is, you
  26. will  have no profile at all since it is a dummy profile).
  27.  
  28. 4/  Eventually  enter  SET  E!PATH=path;path;..... at the DOS prompt. If E!
  29. don't  find  the  specified  files in the current directory, it will search
  30. in all paths specified in E!PATH or in the APPEND command of DOS.
  31.  
  32. 5/ Include the directory where you installed E! in your PATH command.
  33.  
  34. So far, you're done.
  35.  
  36. To edit one or more files enter
  37.  
  38. E! filespec1 filespec2 ....
  39.  
  40. at the DOS prompt.
  41.  
  42. /L  or  /l anywhere on the command line will reload all files edited in the
  43. last  session  of  E!  in the current directory ( if you have activated the
  44. LOG switch in your active profile).
  45.  
  46. To  print  the  documentation,  just  enter  "type e!.doc > prn" at the DOS
  47. prompt. E!.DOC is pre-paginated.
  48.  
  49. I really hope E! will be very useful to you and pleasant to use. Have fun!
  50.  
  51.  
  52. ┌──────────┐
  53. │E! HISTORY│
  54. └──────────┘
  55.  
  56. I'm  a  System  Engineer  working  at  IBM  in  France and I used many text
  57. editors  in  my  programmer's life. The best tools I've seen (until I wrote
  58. E!)  are  BRIEF  and  E3,  an  IBM  internal use only editor. They are very
  59. powerful  programs  but  they  both  have the same drawback : they have not
  60. many  basic  functions  and  they  have  to  be  programmed  to  offer more
  61. sophisticated  functionalities.  Well,  I  think  many people don't want to
  62. spend  time  programming  the  tool  they use to write programs... Hmm, you
  63. see the idea?
  64.  
  65. So  I  wrote  E!. Many functions, quick, efficient, macros capabilities but
  66. no  programming  (at  least  in  the  first  versions). I'm personnaly very
  67. pleased with the result but it's up to you to say if you are too.
  68.  
  69. Many  users  told  me it was necessary to do something more than the simple
  70. macros  implementation.  So the E! API was written, allowing the programmer
  71. to use his usual programming language to write new E! functions and add-in.
  72.  
  73. It  took  many of my time from the past two years to write this program but
  74. it  was  really exciting. It was first written using Turbo Pascal 3.0 but I
  75. quickly  got  problems with the program size and I used Turbo Power's Turbo
  76. Extender  to  produce  a  150  kb  monster.  Versions  2.x  and  3.x  where
  77. rewritten  using  Turbo  Pascal  4.0 and Assembly language (Microsoft MASM)
  78. for  some  video  routines. Version 4.0 has been compiled with Turbo Pascal
  79. 5.0.  Beta  testers  were  professional  programmers.  They  have been very
  80. cruel to me but this helped a lot... and now they're using E!.
  81.  
  82. Planned enhancements are :
  83.  
  84. ("planned  enhancement"  has here the same meaning as in the IBM dialect; I
  85. sincerely plan to do this but I can't tell when I'll achieve it)
  86.  
  87. - Swapping to disk when calling DOS (but it's not very easy because of the
  88.   E! API specifications).
  89. - Regular search expressions (although I never used them with other
  90.   editors but many people do)
  91. - EMS support (it will be very difficult due to the E! structure)
  92. - OS/2 version
  93.  
  94. All  this  will  depend  on  the  success  E!  will gain among text editors
  95. users.
  96.  
  97. There  are many techniques used to design a text editor. Linked list method
  98. (Borland  Editor  toolbox)  is  very  easy  to  implement but has very poor
  99. performances.  Moreover,  block  manipulation is very difficult with such a
  100. structure.  The  "contiguous  block"  design and the "contiguous block with
  101. moving  hole"  design are very efficient for string search but too slow for
  102. lines  or  strings  insertion  when  the  block  becomes  bigger.  I used a
  103. technique that could be called "dynamic pointers arrays allocation". A text
  104. in E! is represented by an array of pointers to text strings. This array is
  105. an  element  of  a  larger  structure  describing  the  current text. These
  106. structures are linked together in a circular list. A new text structure can
  107. easily  be created and inserted in the circular list. The big difficulty is
  108. to  manage  the pointers arrays size when the text is loaded and when lines
  109. are inserted.
  110.  
  111. This  method  cumulate  advantages  of  other methods and has few drawbacks
  112. (except  EMS  cannot  easily be implemented). It is easier to manage blocks
  113. with  an  array  of  strings. But since this array is actually not an array
  114. of  fixed  length  strings  but  an  array  of  pointers to strings, memory
  115. resources  can  be  managed efficiently and no space is wasted. In E! there
  116. is  never  ONE  extra  byte  allocated for a string that shouldn't need it.
  117. Inserting  and  deleting  lines  in  such a structure is very easy since we
  118. have    only    to    move    pointers    and    not   whole   strings.
  119.  
  120. ┌──────────────────────────────────────────────┐
  121. │MODIFICATIONS SINCE LAST DOCUMENTATION UPDATE │
  122. └──────────────────────────────────────────────┘
  123.  
  124.  
  125.                        << NO MODIFICATION >>
  126.  
  127.  
  128.  
  129. ┌──────────────────────────┐
  130. │E! TIPS, CAVEATS and HINTS│
  131. └──────────────────────────┘
  132.  
  133. If  you  use E! as "every day's" editor you may want to copy E!.EXE and all
  134. files  related  to  E!  on  your RAM disk (if you ever installed any one on
  135. your  system)  each  time you initialize your computer (autoexec.bat). This
  136. way,  E!  will  edit  your  files very quickly and your macros will execute
  137. quicker  (although  they perform very good even if you run them from a hard
  138. disk).  Don't  forget  to  set  the  E!  environment  variable to the right
  139. value.  Likewise,  il  will  be a good idea to install H!.EXE and P!.EXE on
  140. your RAM disk.
  141.  
  142.                         **************
  143.  
  144. Personally,  I  have  programming profiles and text editing profiles. I use
  145. different  color  settings  for  each  profile  type.  So, I always know by
  146. simply looking at the screen which profile is active.
  147.  
  148.  
  149.                         **************
  150.  
  151. Macros  are  generally  used to avoid repetitive tasks but you can also use
  152. macros to implement new E! functions. Here is a little example:
  153.  
  154. Generate the following macros using MACGEN and name them:
  155.  
  156. GOLEFT.MAC             GORIGHT.MAC
  157.  
  158. [EDITMODE]             [EDITMODE]
  159. [BLOCK_MARK]           [BLOCK_MARK]
  160. [LEFT]                 [RIGHT]
  161. [MOVE_BLOCK]           [RIGHT]
  162. [UNMARK]               [MOVE_BLOCK]
  163.                        [LEFT]
  164.                        [UNMARK]
  165.  
  166. I  have  assigned  these  macros  to my Alt F11 and Alt F12 keys. Now, if I
  167. hit  one  of  these  keys,  the  current character is moved smoothly to the
  168. left  or  to  the  right.  This  is very useful, for example, when you type
  169. characters in reverse order.
  170.  
  171.                         **************
  172.  
  173. Don't set the DELAY value too low. It could then be possible that you never
  174. see the E! messages.
  175.  
  176.                         **************
  177.  
  178. Deleting a very big block or group of lines may take a few seconds. This is
  179. because E! is trying to keep your memory space as clean as possible. So, it
  180. will be possible to run bigger programs when you make a DOS "shell".
  181.  
  182.                         **************
  183.  
  184. If  you  receive  a  "source and destination conflict" message when you are
  185. trying to move a block with Alt M, use the Alt A (adjust) function instead.
  186.  
  187.                         **************
  188.  
  189. The  E!  HELP  file  can not be as accurate as the E! documentation. If you
  190. get  inconsistent  information  between  the  HELP  file and E!.DOC, always
  191. believe E!.DOC. H! is a more complete and independent HELP program.
  192.  
  193.                         **************
  194.  
  195. I'm  aware  that  my english is poor. I'm sorry if this makes some parts of
  196. the E! documentation unreadable (I don't really think so but I can't be the
  197. judge in that matter).
  198.  
  199.                         **************
  200.  
  201. The  file  compression  process  does  not preserve file attributes. So the
  202. following files should be set to "read-only":
  203.  
  204.         E!.HLP     E!KEY.HLP     E!.MSG
  205.  
  206. To do so, use the DOS "ATTRIB" command.
  207.  
  208.                         **************
  209.  
  210. Don't  set  the  TYPEMATIC  autorepeat  rate  too  high. You could find you
  211. deleting more lines than you really wish to (I told you E! is quick).
  212.  
  213.                         **************
  214.  
  215. This  will  be  repeated  in the E! documentation but it is VERY important.
  216. DO  NOT  SET  the  "IBM101T" profile command to YES unless your computer is
  217. equipped  with  an  enhanced  keyboard  BIOS.  That  is,  a BIOS processing
  218. services  #10h  and  #11h  of the BIOS 16H interrupt handler. Doing so will
  219. cause your machine to hang.
  220.  
  221.                         **************
  222.  
  223. If  the  current  text  path  is  very  long ( over 47 characters), it will
  224. appear  truncated  on  the  command line. Don't worry. This is only done at
  225. display time.
  226.  
  227.                         **************
  228.  
  229. Patrick PHILIPPOT. 1/5/89
  230. ******************************************************************************
  231.  
  232.